Variable Reference
Variables allow AwareEd notifications to be tailored to your learners. Note that variables are not supported in the notification subject line at this time. The following variables are supported:
| Variable | Description |
|---|---|
| {{#if completion_certificate_link}} | Inserts link to download learner completion certificate if available. This can only be used in a completion notification, and completion certificates are optional. |
| {{campaign}} | Inserts the name of the campaign. Example: “Q1 Awareness Training” |
| {{campaign_branding_color}} | Inserts the color of the campaigns branding, in hexadecimal format. Example: #60C8A0
|
| {{campaign_branding_logo}} | Inserts an image tag with your campaign brand logo as the image source, and your account name as its alt text. Example: <img alt="Company Name" src="https://example.com/company/logo.png">
|
| {{campaign_branding_logo_url}} | Inserts the URL to the campaigns branding logo. Example: https://example.com/company/logo.png
|
| {{campaign_due_date}} | Inserts the end date of the current campaign run. |
| {{course}} | Inserts the name of the course associated with the campaign. Example: “Popular Modules” |
| {{customer}} | Inserts the name of your account (not the learner) found in the user information section fo the account settings. |
| {{customer_email}} | Inserts the email associated with your account (not the learner) found in the user information section fo the account settings. |
| {{days_since_start}} | Inserts the number of days since the campaign started. |
| {{days_until_end}} | Inserts the number of days until the campaign ends. |
| {{header}} | Inserts the default notification header with your branding logo and branding color as the background color. |
| {{learner}} | Inserts the first and last name of the learner with a space in between the names. Example: “John Smith”. Note: this value may be blank if this value was not configured. |
| {{learner_address1}} | Inserts the address of the learner. |
| {{learner_address2}} | Inserts the address of the learner. |
| {{learner_city}} | Inserts the city of the learner. |
| {{learner_country}} | Inserts the country of the learner. |
| {{learner_custom}} | Inserts the Custom field from the learner profile. |
| {{learner_custom2}} | Inserts the Custom2 field from the learner profile. |
| {{learner_custom3}} | Inserts the Custom3 field from the learner profile. |
| {{learner_custom4}} | Inserts the Custom4 field from the learner profile. |
| {{learner_custom5}} | Inserts the Custom5 field from the learner profile. |
| {{learner_custom6}} | Inserts the Custom6 field from the learner profile. |
| {{learner_department}} | Inserts the department of the learner. |
| {{learner_email}} | Inserts the email address of the learner. Example: john.smith@example.com
|
| {{learner_first}} | Inserts the last name of the learner. Example: “John”. Note: this value may be blank if this value was not configured. |
| {{learner_last}} | Inserts the first name of the learner. Example: “Smith”. Note: this value may be blank if this value was not configured. |
| {{learner_manager_email}} | Inserts the learner’s manager email address of the learner. |
| {{learner_manager_name}} | Inserts the learner’s manager name of the learner. |
| {{learner_phone}} | Inserts the phone number of the learner. |
| {{learner_state}} | Inserts the state of the learner. |
| {{learner_title}} | Inserts the title of the learner. |
| {{learner_zip}} | Inserts the zip code of the learner. |
| {{module_count}} | Inserts the number of modules in the course associated with the campaign. |
| {{training_link}} | Provides a link to a page where the learner may take their training and view progress against the entire course. This variable is recommended in Enrollment and Reminder notifications. Note that links are unique to each learner and should not be shared between learners. |
| {{training_url}} | Provides a URL to a page where the learner may take their training and view progress against the entire course. |
Sample Notifications
Sample Enrollment Email
{{header}}
Hello {{learner}} ({{learner_email}}),
You have been enrolled in computer-based Security Awareness Training!
To access your training, please follow this link: {{training_link}} Note that NO username and password is required. The course you are taking is called “{{course}}”, is being directed at “{{campaign}}”, and includes {{module_count}} interactive training modules. You have {{days_until_end}} to complete your training and you will be reminded to complete it every few days. For the best possible experience, you should plan on taking your training at a computer with audio, but closed captions are also provided if audio is not an option.
Thank you!
{{customer}}
Sample Reminder to Start Notification
{{header}}
Hello {{learner}} ({{learner_email}}),
It’s time to start your computer-based Security Awareness Training! To begin your training, follow this link: {{training_link}}
You have {{days_until_end}} to complete your training. For the best possible experience, you should plan on taking your training at a computer with audio, but closed captions are also provided if audio is not an option.
Sample Reminder to Finish
{{header}}
Hello {{learner}} ({{learner_email}}),
This is just a reminder to complete your computer-based Security Awareness Training! To complete your training, follow this link: {{training_link}}
You have {{days_until_end}} to complete your training. For the best possible experience, you should plan on taking your training at a computer with audio, but closed captions are also provided if audio is not an option.
Sample Completion Notification
{{header}}
Congratulations {{learner}} ({{learner_email}})!
You have successfully completed your computer-based Security Awareness Training!
For your information, it took you {{days_since_start}} to complete all {{module_count}} modules in the “{{course}}” training course.
Please save or print a copy of this email for your records.
{{#if completion_certificate_link}}